Documentation
Pour les utilisateurs
Pour les développeurs
Liste des blocs
Annuaire
Bandeau
Bouton
Catégorie
Formulaire
Galerie
Groupe de blocs
Image
Inscription
LEI
Logo du site
Menu
Menu de langue
Page
Plan du site
Recherche
Réseaux sociaux
Résumé
Rubrique
Slider
Template
Texte
Titre
Type de catégorie
Vidéo
Vidéos
Vignette
Annuaire
Liste tous les utilisateurs inscrits sur le site
Identifiant
Annuaire
Paramètres
- limite : limitation du nombre de résultats
- pagination : activation/désactivation de la pagination
- resultatsParPage : nombre de résultats par page si la pagination est activée
Fonctionnement
Template "Annuaire.html.twig" -> appelle la fonction twig "listeUtilisateurs(parametres)" située dans "AnnuaireTwig.php" -> récupère la liste de tous les utilisateurs et génère la pagination
Bandeau
Bloc annexe - Affiche une image qui illustre la page
Identifiant
Bandeau
Paramètres
- image (défini dans "src/Form/Type/ImageDefautType.php")
- image, externe ou de la médiathèque
- titre : légende de l'image
- description : attribut "alt" de la balise img
Fonctionnement
Template "Bandeau.html.twig" -> affiche l'image choisie
Bouton
Lien sous forme de bouton, vers une page interne ou externe ou un fichier
Identifiant
Bouton
Paramètres
- lien
- blank : ouverture du lien dans un nouvel onglet ?
- texte : texte du bouton
- titre : attribut title de la balise a
Fonctionnement
Template "Bouton.html.twig" -> affiche le bouton
Catégorie
Liste toutes les pages appartenant à une catégorie spécifiée, ou à au moins une catégorie
Identifiant
Categorie
Paramètres
- categorie : choix de la catégorie dont il faut afficher les pages ("toutes" = afficher les pages faisant partie d'au moins une catégorie)
- limite : limitation du nombre de résultats
- pagination : activation/désactivation de la pagination
- resultatsParPage : nombre de résultats par page si la pagination est activée
Fonctionnement
Template "Categorie.html.twig" -> appelle la fonction twig "pagesDeLaCategorie(langue, parametres)" située dans "CategorieTwig.php" -> récupère la liste de toutes les pages appartenant à cette catégorie / appartenant à au moins une catégorie
Formulaire
Formulaire à champs paramétrables, envoyé par mail à différents destinataires
Identifiant
Formulaire
Paramètres
- destinataires : personnes qui recevront le formulaire par mail
- objet : objet du mail qui sera envoyé et qui contiendra le formulaire
- messageConfirmation : message à afficher à l'utilisateur après que le formulaire ait été envoyé
- champs : liste des champs du formulaire (défini dans "ChampType.php")
- type : Type de champ (text, textarea, select, checkbox ou radio)
- position
- requis : le champ est-il obligatoire ?
- label
- choix : la liste des choix possibles, si le champ est de type checkbox ou radio
- submit : texte du bouton d'envoi du formulaire
Fonctionnement
Template "Formulaire.html.twig" -> affiche le formulaire avec les champs définis dans le back-office
Controller "FormulaireController.php" -> gère l'envoi du formulaire par mail
Template "Mail.html.twig" -> template du mail envoyé suite à la soumission du formulaire
Galerie
Liste d'images avec affichage sous forme de lightbox au clic
Identifiant
Galerie
Paramètres
- images : champ répétable (défini dans "GalerieImageType.php")
- image (défini dans "src/Form/Type/ImageDefautType.php")
- image, externe ou de la médiathèque
- titre : légende de l'image
- description : attribut "alt" de la balise img
- position
- image (défini dans "src/Form/Type/ImageDefautType.php")
Fonctionnement
Template "Galerie.html.twig" -> affiche les images. L'attribut "data-fancybox" des liens entourant les images permet de passer d'une image à l'autre dans le lightbox lancé en cliquant sur une des images
Groupe de blocs
Affiche les blocs d'un groupe
Identifiant
GroupeBlocs
Paramètres
- groupeBlocs : le groupe à afficher
Fonctionnement
Template "GroupeBlocs.html.twig" -> appelle la fonction twig groupe(idGroupeBlocs) située dans "src/Twig/Front/Front.php" -> récupère le groupe et ses blocs et retourne un rendu html de son template ("groupe-idDuGroupe.html.twig" ou "groupe.html.twig")
Image
Affiche une image, externe ou issue de la médiathèque
Identifiant
Image
Paramètres
- image, externe ou de la médiathèque
- titre : légende de l'image
- description : attribut "alt" de la balise img
- lien
- blank : ouverture du lien dans un nouvel onglet ?
Fonctionnement
Template "Image.html.twig" -> affiche l'image, entourée d'une balise figure et accompagnée d'une balise figcaption si elle a un titre
Inscription
Affiche un formulaire d'inscription au site
Identifiant
Inscription
Paramètres
Aucun paramètre
Fonctionnement
Template "Inscription.html.twig" -> affiche le formulaire d'inscription du bundle FosUser
LEI
Affiche une liste des fiches LEI issues d'un flux
Identifiant
LEI
Paramètres
- flux : url du flux LEI
- clef_moda : pour limiter les résultats à une clé de modalité
- limite : limitation du nombre de résultats
- pagination : activation/désactivation de la pagination
- resultatsParPage : nombre de résultats par page si la pagination est activée
Fonctionnement
Template "LEI.html.twig" -> appelle la fonction listeLEI(parametres) située dans "LEITwig.php" -> extrait les fiches du flux, les filtre si une clé de modalité a été précisée, génère la pagination
Controller "LeiController.php" -> Permet d'afficher les fiches individuellement, avec une url de la forme /langue/fiche/url/idFiche/idBloc. Le paramètre "url" n'a aucune incidence, il peut donc être généré librement, à partir du titre de la fiche par exemple.
Template "fiche.html.twig" -> affiche une fiche
Logo du site
Affiche le logo et/ou le titre du site
Identifiant
LogoSite
Paramètres
- logo : checkbox, afficher ou non le logo
- nom : checkbox, afficher ou non le titre du site
Fonctionnement
Template "LogoSite.html.twig" -> affiche le logo et/ou le titre du site
Menu
Affiche la liste des pages contenues dans un menu de manière hiérarchique
Identifiant
Menu
Paramètres
- menu : le menu à afficher
Fonctionnement
Template "Menu.html.twig" -> appelle la fonction menu(idMenu) située dans "MenuTwig.php" -> récupère le menu et retourne un rendu html du template "front/menu/menus.html.twig"
Menu de langue
Affiche un menu permettant au visiteur de changer de langue de navigation
Identifiant
MenuLangues
Paramètres
Aucun paramètre
Fonctionnement
Template "MenuLangues.html.twig" -> liste les langues sous forme de bouton, qui permettent de changer de langue au clic grâce à la fonction "changerAction" du controller "src/Controller/LangueController"
Page
Affiche les blocs de contenu d'une autre page
Identifiant
Page
Paramètres
- page : la page dont il faut afficher les blocs
Fonctionnement
Template "Page.html.twig" -> appelle la fonction blocs(idPage) située dans "PageTwig.php" -> recherche la page, récupère ses blocs et retourne un rendu html du template "front/blocs.html.twig"
Plan du site
Affiche tous les menus du site
Identifiant
PlanDuSite
Paramètres
Aucun paramètre
Fonctionnement
Template "PlanDuSite.html.twig" -> appelle la fonction planDuSite() située dans "PlanDuSiteTwig.php", qui récupère tous les menus, puis utilise le template "front/menu/menu.html.twig" pour les afficher
Recherche
Affiche un formulaire de recherche, qui permet de lister les pages dont le titre ou l'un des blocs texte contient l'expression recherchée
Identifiant
Recherche
Paramètres
Aucun paramètre
Fonctionnement
Template "Recherche.html.twig" -> affiche le formulaire de recherche
Controller "RechercheController.php" -> Permet d'afficher les résultats de recherche (càd les pages dont le titre ou l'un des blocs texte contient l'un des mots recherchés)
Template "ResultatsRecherche.html.twig" -> liste les pages correspondantes aux mots recherchés
Réseaux sociaux
Affiche une ou plusieurs icônes renvoyant vers les réseaux sociaux suivants : Facebook, Twitter, Instagram, Youtube et LinkedIn
Identifiant
ReseauxSociaux
Paramètres
- facebook : afficher ou non l'icône Facebook
- facebookUrl : url vers laquelle renvoie l'icône Facebook
- twitter : afficher ou non l'icône Twitter
- twitterUrl : url vers laquelle renvoie l'icône Twitter
- instagram : afficher ou non l'icône Instagram
- instagramUrl : url vers laquelle renvoie l'icône Instagram
- youtube : afficher ou non l'icône Youtube
- youtubeUrl : url vers laquelle renvoie l'icône Youtube
- linkedIn : afficher ou non l'icône LinkedIn
- linkedInUrl : url vers laquelle renvoie l'icône LinkedIn
Fonctionnement
Template "ReseauxSociaux.html.twig" -> affiche les icônes choisies avec un lien vers l'url spécifiée
Résumé
Bloc annexe - texte de présentation de la page
Identifiant
Resume
Paramètres
- resume
Fonctionnement
Template "Resume.html.twig" -> affiche le résumé de la page
Rubrique
Liste les pages enfants d'une page (par rapport au menu principal)
Identifiant
Rubrique
Paramètres
- limite : limitation du nombre de résultats
- pagination : activation/désactivation de la pagination
- resultatsParPage : nombre de résultats par page si la pagination est activée
Fonctionnement
Template "Rubrique.html.twig" -> appelle la fonction listePagesEnfants(pageParent, parametres) située dans "RubriqueTwig.php" -> recherche toutes les pages enfants de la page spécifiée, par rapport au menu principal de la langue de la page, et génère la pagination
Slider
Affiche des images, accompagnées ou non de texte, sous forme de slider
Identifiant
Slider
Paramètres
- nbSlides : nombre de slides à afficher simultanément
- autoplay : checkbox, activation ou non du défilement automatique
- fleches : checkbox, affichage ou non des flèches de navigation
- points : checkbox, affichage ou non des points de navigation
- Slide : champ répétable (défini dans "SlideType.php")
- image (défini dans "src/Form/Type/ImageDefautType.php")
- image, externe ou de la médiathèque
- titre : légende de l'image
- description : attribut "alt" de la balise img
- position : champ caché, géré par drag'n'drop
- texte
- lien : peut être utilisé pour un bouton "lire la suite" par exemple
- image (défini dans "src/Form/Type/ImageDefautType.php")
Fonctionnement
Template "Slider.html.twig" -> affiche le slider et déclenche son lancement via un une balise script (slider SlickSlider)
Template
Appelle un template
Identifiant
Template
Paramètres
- template : chemin du template à appeler
Fonctionnement
Template "Template.html.twig" : inclut le template spécifié
Texte
Affiche du texte, éditable dans le back-office grâce à l'éditeur wysiwyg TinyMCE
Identifiant
Texte
Paramètres
- texte
Fonctionnement
Template "Texte.html.twig" -> affiche le texte sans retirer les balises html
Titre
Affiche du texte, entouré de la balise choisie
Identifiant
Titre
Paramètres
- texte
- balise : h2, h3, h4 ou p
Fonctionnement
Template "Titre.html.twig" -> affiche le titre entouré de la balise choisie
Type de catégorie
Affiche toutes les catégories appartenant à un type de catégorie
Identifiant
TypeCategorie
Paramètres
- typeCategorie : choix du type de catégorie dont il faut afficher les catégories
- limite : limitation du nombre de résultats
Fonctionnement
Template "TypeCategorie.html.twig" -> appelle la fonction categoriesDeType(idTypeCategorie) située dans "TypeCategorieTwig.php" -> récupère toutes les catégories du type spécifié
Vidéo
Affiche une vidéo Youtube
Identifiant
Video
Paramètres
- video : identifiant de la vidéo
Fonctionnement
Template "Video.html.twig" -> Affiche la vidéo grâce à une iframe
Videos
Affiche toutes les vidéos contenues dans des blocs vidéo
Identifiant
Videos
Paramètres
- limite : limitation du nombre de résultats
- pagination : activation/désactivation de la pagination
- resultatsParPage : nombre de résultats par page si la pagination est activée
Fonctionnement
Template "Videos.html.twig" -> appelle la fonction listeVideos(langue, parametres) située dans "VideosTwig.php" -> récupère tous les blocs vidéo et génère la pagination
Vignette
Bloc annexe - image de présentation de la page
Identifiant
Vignette
Paramètres
- image (défini dans "src/Form/Type/ImageDefautType.php")
- image, externe ou de la médiathèque
- titre : légende de l'image
- description : attribut "alt" de la balise img
Fonctionnement
Template "Vignette.html.twig" -> affiche l'image choisie